home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 301-325 / disk_319 / cnewssrc / cnews.orig.lzh / man / expire.man < prev    next >
Text File  |  1989-06-28  |  12KB  |  265 lines
  1.  
  2.  
  3.  
  4.      EEEEXXXXPPPPIIIIRRRREEEE((((8888))))             CCCC NNNNeeeewwwwssss ((((5555 JJJJuuuunnnneeee 1111999988889999))))              EEEEXXXXPPPPIIIIRRRREEEE((((8888))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           expire, doexpire - expire old news
  10.           mkhistory - rebuild news history file
  11.           upact - update news active file
  12.           superkludge - implement stupid Supersedes header in news
  13.  
  14.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.           ////uuuussssrrrr////lllliiiibbbb////nnnneeeewwwwssssbbbbiiiinnnn////eeeexxxxppppiiiirrrreeee////eeeexxxxppppiiiirrrreeee [ ----aaaa archdir ] [ ----pppp ] [ ----ssss ]
  16.           [ ----FFFF c ] [ ----cccc ] [ ----nnnn nnnnn ] [ ----tttt ] [ ----llll ] [ ----vvvv ] [ ----dddd ] [
  17.           controlfile ]
  18.           ////uuuussssrrrr////lllliiiibbbb////nnnneeeewwwwssssbbbbiiiinnnn////eeeexxxxppppiiiirrrreeee////ddddooooeeeexxxxppppiiiirrrreeee expireoptions
  19.           ////uuuussssrrrr////lllliiiibbbb////nnnneeeewwwwssssbbbbiiiinnnn////eeeexxxxppppiiiirrrreeee////mmmmkkkkhhhhiiiissssttttoooorrrryyyy
  20.           ////uuuussssrrrr////lllliiiibbbb////nnnneeeewwwwssssbbbbiiiinnnn////eeeexxxxppppiiiirrrreeee////uuuuppppaaaacccctttt
  21.           ////uuuussssrrrr////lllliiiibbbb////nnnneeeewwwwssssbbbbiiiinnnn////eeeexxxxppppiiiirrrreeee////ssssuuuuppppeeeerrrrkkkklllluuuuddddggggeeee [ ----vvvv ] newsgroup ...
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           _E_x_p_i_r_e expires old news, removing it from the current-news
  25.           directories and (if asked to) archiving it elsewhere.  It
  26.           updates news's _h_i_s_t_o_r_y file to match.  _E_x_p_i_r_e should
  27.           normally be run nightly, typically by using _d_o_e_x_p_i_r_e (see
  28.           below).
  29.  
  30.           _E_x_p_i_r_e's operations are controlled by a control file (which
  31.           can be named or supplied on standard input), which is not
  32.           optional-there is no default behavior.  Each line of the
  33.           control file should have four white-space-separated fields,
  34.           as follows.
  35.  
  36.           The first field is one or more newsgroups, separated by
  37.           commas (no spaces!); partial specifications are acceptable
  38.           (e.g. `comp' specifies all groups with that prefix).
  39.  
  40.           The second field is one letter, `m', `u', or `x', specifying
  41.           that the line applies only to moderated groups, only to
  42.           unmoderated groups, or to both, respectively.
  43.  
  44.           The third field specifies the expiry period in days.  The
  45.           most general form is three numbers separated by dashes.  The
  46.           units are days; decimal fractions are permitted.  The first
  47.           number gives the retention period: how long must pass after
  48.           an article's arrival before it is a candidate for expiry.
  49.           The third number gives the purge date: how long must pass
  50.           after arrival before the article will be expired
  51.           unconditionally.  The middle number gives the default expiry
  52.           date: how long after an article's arrival it is expired by
  53.           default.  An explicit expiry date in the article will
  54.           override the default expiry date but not the retention
  55.           period or the purge date.  If the field contains only two
  56.           numbers with a dash separating them, the retention period
  57.           defaults to 0.  If the field contains only a number, the
  58.           retention period defaults to 0 and the purge date defaults
  59.           to `never'.  (But see below.)
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 6/29/89)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      EEEEXXXXPPPPIIIIRRRREEEE((((8888))))             CCCC NNNNeeeewwwwssss ((((5555 JJJJuuuunnnneeee 1111999988889999))))              EEEEXXXXPPPPIIIIRRRREEEE((((8888))))
  71.  
  72.  
  73.  
  74.           The fourth field is an archiving directory, or `@' which
  75.           indicates that the default archiving directory (see ----aaaa)
  76.           should be used, or `-' which suppresses archiving.  An
  77.           explicit archiving directory (not `@') prefixed with `='
  78.           means that articles should be archived into that directory
  79.           itself; normally they go into subdirectories under it by
  80.           newsgroup name, as in the current-news directory tree.
  81.           (E.g., article 123 of comp.pc.drivel being archived into
  82.           archive directory /_e_x_p would normally become
  83.           /_e_x_p/_c_o_m_p/_p_c/_d_r_i_v_e_l/_1_2_3, but if the archiving directory was
  84.           given as `=/exp' rather than `/exp', it would become
  85.           /_e_x_p/_1_2_3.) _E_x_p_i_r_e creates subdirectories under an archiving
  86.           directory automatically, but will not create the archiving
  87.           directory itself.  Archiving directories must be given as
  88.           full pathnames.
  89.  
  90.           The first line of the control file which applies to a given
  91.           article is used to control its expiry.  It is an error for
  92.           no line to apply; the last line should be something like
  93.           `all x 7 -' to ensure that at least one line is always
  94.           applicable.  Cross-posted articles are treated as if they
  95.           were independently posted to each group.
  96.  
  97.           The retention and purge defaults can be overridden by
  98.           including a _b_o_u_n_d_s line, one with the special first field
  99.           ////bbbboooouuuunnnnddddssss////; the retention and purge defaults for following
  100.           lines will be those of the bounds line.  The other fields of
  101.           a bounds line are ignored but must be present.
  102.  
  103.           Entries in the _h_i_s_t_o_r_y file can be retained after article
  104.           expiry, to stop a late-arriving copy of the article from
  105.           being taken as a new article.  To arrange this, include a
  106.           line with the special first field ////eeeexxxxppppiiiirrrreeeedddd////; this line then
  107.           controls the expiry of _h_i_s_t_o_r_y lines after the corresponding
  108.           articles expire.  Dates are still measured from article
  109.           arrival, not expiry.  The other fields of such a line are
  110.           ignored but must be present.  It is strongly recommended
  111.           that such a line be included, and that it specify as long a
  112.           time as practical.
  113.  
  114.           Command-line options are:
  115.  
  116.           ----aaaa dir    _d_i_r is the default archiving directory; if no
  117.                     default is given, the control file may not contain
  118.                     any `@' archive-directory fields.
  119.  
  120.           ----pppp        print an `index' line for each archived article,
  121.                     containing its pathname, message ID, date
  122.                     received, and `Subject:' line.
  123.  
  124.           ----ssss        space is tight; optimize error recovery to
  125.                     minimize space consumed rather than to leave as
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 6/29/89)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      EEEEXXXXPPPPIIIIRRRREEEE((((8888))))             CCCC NNNNeeeewwwwssss ((((5555 JJJJuuuunnnneeee 1111999988889999))))              EEEEXXXXPPPPIIIIRRRREEEE((((8888))))
  137.  
  138.  
  139.  
  140.                     much evidence as possible.
  141.  
  142.           ----FFFF c      the subfield separator character in the middle
  143.                     _h_i_s_t_o_r_y field is _c rather than the normal `~'.
  144.  
  145.           ----cccc        check the format and consistency of the control
  146.                     file and the _a_c_t_i_v_e file, but do not do any
  147.                     expiring.
  148.  
  149.           ----nnnn nnnnn  set _e_x_p_i_r_e's idea of the time to _n_n_n_n_n (for
  150.                     testing).
  151.  
  152.           ----tttt        print (on standard error) a shell-script-like
  153.                     description of what would be done, but don't do
  154.                     it.
  155.  
  156.           ----llll        consider first filename in a _h_i_s_t_o_r_y line to be
  157.                     the _l_e_a_d_e_r of its line, to be expired only after
  158.                     all others have expired.  (Meant for use on
  159.                     obnoxious systems like VMS which don't support
  160.                     real links.)
  161.  
  162.           ----vvvv        verbose: report some statistics after termination.
  163.  
  164.           ----dddd        turn on (voluminous and cryptic) debugging output.
  165.  
  166.           _E_x_p_i_r_e considers the middle field of a _h_i_s_t_o_r_y line to
  167.           consist of one or more subfields separated by `~'.  The
  168.           first is the arrival date, which can be either a
  169.           _g_e_t_d_a_t_e(3)-readable date or a decimal seconds count; _e_x_p_i_r_e
  170.           leaves this field unchanged.  The second-if present, non-
  171.           null, and not `-'-is an explicit expiry date for the file,
  172.           again in either format, which _e_x_p_i_r_e will convert to a
  173.           decimal seconds count as it regenerates the _h_i_s_t_o_r_y file.
  174.           Subsequent fields are preserved but ignored.
  175.  
  176.           _D_o_e_x_p_i_r_e checks whether another _d_o_e_x_p_i_r_e is running, checks
  177.           that there is enough disk space for expiry and archiving,
  178.           invokes _e_x_p_i_r_e with any _e_x_p_i_r_e_o_p_t_i_o_n_s given and with
  179.           /_u_s_r/_l_i_b/_n_e_w_s/_e_x_p_l_i_s_t as the control file, and reports any
  180.           difficulties by sending mail to _u_s_e_n_e_t.  This is usually
  181.           better than just running _e_x_p_i_r_e directly.
  182.  
  183.           _M_k_h_i_s_t_o_r_y rebuilds the _h_i_s_t_o_r_y file and its auxiliaries to
  184.           match the articles in /_u_s_r/_s_p_o_o_l/_n_e_w_s.  _U_p_a_c_t updates the
  185.           third fields of the _a_c_t_i_v_e file to match the articles in
  186.           /_u_s_r/_s_p_o_o_l/_n_e_w_s (for historical reasons, _e_x_p_i_r_e does not do
  187.           this).  These programs are both fairly slow and they both
  188.           lock the whole news system for the duration of the run, so
  189.           they should not be run casually.
  190.  
  191.           _S_u_p_e_r_k_l_u_d_g_e inspects the files in /_u_s_r/_s_p_o_o_l/_n_e_w_s for the
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 6/29/89)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      EEEEXXXXPPPPIIIIRRRREEEE((((8888))))             CCCC NNNNeeeewwwwssss ((((5555 JJJJuuuunnnneeee 1111999988889999))))              EEEEXXXXPPPPIIIIRRRREEEE((((8888))))
  203.  
  204.  
  205.  
  206.           _n_e_w_s_g_r_o_u_p(s) given, and removes any that have been
  207.           superseded, according to the `Supersedes' header, by newer
  208.           ones.  The _h_i_s_t_o_r_y file is not altered; it's not worth the
  209.           trouble.  The ----vvvv option produces a report of how many
  210.           articles have been superseded in each _n_e_w_s_g_r_o_u_p.
  211.  
  212.      FFFFIIIILLLLEEEESSSS
  213.           /usr/lib/news/history   history file
  214.           /usr/lib/news/history.pag_d_b_m database for history file
  215.           /usr/lib/news/history.dir_d_b_m database for history file
  216.           /usr/lib/news/explist   expiry control file
  217.           /usr/lib/news/history.o history file as of last expiry
  218.           /usr/lib/news/history.n*new history file and _d_b_m files abuilding
  219.           /usr/lib/news/LOCKexpire_d_o_e_x_p_i_r_e's lock file
  220.           /usr/lib/newsbin/expire/*various auxiliaries
  221.  
  222.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  223.           inews(1), dbm(3), relaynews(8)
  224.  
  225.      HHHHIIIISSSSTTTTOOOORRRRYYYY
  226.           Written at U of Toronto by Henry Spencer, with contributions
  227.           by Geoff Collyer.
  228.  
  229.      BBBBUUUUGGGGSSSS
  230.           Archiving is always done by copying, never by linking.  This
  231.           has the side effect that cross-posted articles are archived
  232.           as several independent copies.
  233.  
  234.           The ----pppp subject-finder botches continued header lines, as
  235.           does _m_k_h_i_s_t_o_r_y, although such lines are rare.
  236.  
  237.           _U_p_a_c_t and _s_u_p_e_r_k_l_u_d_g_e are distasteful kludges, but then, so
  238.           are the third field of the _a_c_t_i_v_e file and the `Supersedes'
  239.           header.
  240.  
  241.           Some of the more obscure options of _e_x_p_i_r_e have not been
  242.           tested well.
  243.  
  244.           One cannot put more than one newsgroup into a single
  245.           archiving directory with the `=' feature, since the article
  246.           numbers will collide with each other and expire doesn't do
  247.           anything about this.
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 6/29/89)
  262.  
  263.  
  264.  
  265.